Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.
Setup code
To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:
library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)
plotly_widget <- plot_ly(x = diamonds$cut) %>%
config(displayModeBar = FALSE) %>%
layout(margin = list(t = 0, b = 0, l = 0, r = 0))
leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
leaflet(options = .) %>%
addTiles()Shiny usage
Cards work equally well in Shiny. In the
examples below, replace plotly_widget with
plotlyOutput() and leaflet_widget with
leafletOutput() to adapt them for Shiny server-rendered
plots/maps.
Hello card()
A card() is designed to handle any number of “known”
card items (e.g., card_header(), card_body(),
etc) as unnamed arguments (i.e., children). As we’ll see shortly,
card() also has some useful named arguments (e.g.,
full_screen, height, etc).
At their core, card() and card items are just an HTML
div() with a special Bootstrap class, so you can use
Bootstrap’s utility classes to customize things like colors,
text, borders,
etc.
card(
card_header(
class = "bg-dark",
"A header"
),
card_body(
markdown("Some text with a [link](https://github.com)")
)
)Some text with a link
Implicit card_body()
If you find yourself using card_body() without changing
any of its defaults, consider dropping it altogether since any direct
children of card() that aren’t “known” card()
items, are wrapped together into an implicit card_body()
call.1
For example, the code to the right generates HTML that is identical to
the previous example:
card(
card_header(
class = "bg-dark",
"A header"
),
markdown("Some text with a [link](https://github.com).")
)Some text with a link.
Restricting growth
By default, a card()’s size grows to accommodate the
size of its contents. Thus, if a card_body() contains a
large amount of text, tables, etc., you may want to specify a
height or max_height. That said, when laying
out multiple cards, it’s likely best not
to specify height on the card(), and instead, let the
layout determine the height layout_column_wrap().
Although scrolling is convenient for reducing the amount of space
required to park lots of content, it can also be a nuisance to the user.
To help reduce the need for scrolling, consider pairing scrolling with
full_screen = TRUE (which adds an icon to expand the card’s
size to the browser window). Notice how, when the card is expanded to
full-screen, max_height/height won’t effect
the full-screen size of the card.
card(
max_height = 250,
full_screen = TRUE,
card_header(
"A long, scrolling, description"
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Dolor fringilla lectus velit vestibulum, lobortis – aenean nullam, elementum tristique aliquet senectus. Inceptos consequat integer egestas facilisis aliquam ligula curae curabitur ut ornare. Litora ad mus parturient egestas – euismod pulvinar diam elementum tincidunt feugiat dui eros? Augue auctor orci commodo condimentum himenaeos ultricies quis! Placerat arcu nam turpis parturient integer.
Ipsum convallis rutrum nascetur class blandit varius aliquet mus senectus! Libero ligula per sed placerat: congue ac ultricies facilisis arcu eget netus? Donec faucibus arcu, hac feugiat tempor felis. Donec per leo aliquam sagittis turpis torquent inceptos. Augue eros nec convallis blandit diam; nunc ad curabitur ad a eros!
Sit lacus etiam; pellentesque condimentum eleifend dapibus quisque feugiat fames. Commodo mattis vulputate inceptos ullamcorper laoreet id lacus, hac habitasse nullam varius sociis. Primis per, fringilla conubia malesuada inceptos rutrum torquent sociis magna cras? Integer tristique porttitor mattis. Gravida libero ad eros faucibus placerat potenti venenatis posuere gravida egestas, nibh cubilia vestibulum convallis viverra condimentum hendrerit curabitur!
Filling outputs
A card()’s default behavior is optimized for
facilitating filling layouts. More
specifically, if a fill item (e.g.,
plotly_widget), appears as a direct child of a
card_body(), it resizes to fit the card()s
specified height. This means, by specifying height = 250
we’ve effectively shrunk the plot’s height from its default of 400 down
to about 200 pixels. And, when expanded to full_screen, the
plot grows to match the card()’s new size.
card(
height = 250,
full_screen = TRUE,
card_header("A filling plot"),
card_body(plotly_widget)
)Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny
output bindings (e.g, plotOutput(),
imageOutput(), etc) are fill items by
default, so this behavior “just works” in those scenarios. And, in some
of these situations, it’s helpful to remove card_body()’s
padding, which can be done via spacing
& alignment utility classes.
card(
height = 275,
full_screen = TRUE,
card_header("A filling map"),
card_body(
class = "p-0",
leaflet_widget
),
card_footer(
class = "fs-6",
"Copyright 2023 RStudio, PBC"
)
)Fill item(s) aren’t limited in how much they grow
and shrink, which can be problematic when a card becomes very small. To
work around this, consider adding a min_height on the
card_body() container. For example, try using the handle on
the lower-right portion of this card example to make the card
taller/smaller.
This interactive example is a bit contrived in that we’re using CSS
resize to demonstrate how to make plots that don’t shrink beyond a
certain point, but this concept becomes quite useful when implementing
page-level filling layouts (i.e.,
page_fillable()) with multiple
cards.
card(
height = 300,
style = "resize:vertical;",
card_header("Plots that grow but don't shrink"),
card_body(
min_height = 250,
plotly_widget,
plotly_widget
)
)Troubleshooting fill
As you’ll learn more about in filling
layouts, a fill item loses its ability to fill when
wrapped in additional UI element that isn’t a fillable
container. To fix the situation, use as_fill_carrier() to
allow the additional element to carry the potential to fill from the
card_body() down to the fill item.
Multiple card_body()
A card() can have multiple card_body()s,
which is especially useful for:
- Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
- Allowing each
card_body()to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g.,min_height).
For example, when pairing filling output with scrolling content, you
may want min_height on the filling output since the
scrolling content will force it to shrink:
card(
height = 375,
full_screen = TRUE,
card_header(
"Filling plot, scrolling description"
),
card_body(
min_height = 200,
plotly_widget
),
card_body(
class = "lead container",
lorem::ipsum(paragraphs = 10, sentences = 5)
)
)Amet aliquet libero blandit metus, etiam tempor mauris sapien ultricies. Ultricies purus faucibus lectus natoque iaculis at – fames, et cursus? Nulla leo netus bibendum neque eget magnis mi mus nostra? Dapibus vitae congue lobortis, iaculis cursus consequat maecenas himenaeos ac? Na ac.
Elit aenean scelerisque sed hendrerit, fermentum libero, rutrum tincidunt massa tincidunt est. Pellentesque tincidunt porta gravida etiam pretium inceptos nunc aliquet montes fermentum, curabitur feugiat dapibus? Ut laoreet imperdiet; convallis massa mauris morbi nostra, mattis convallis integer. Curabitur penatibus potenti litora in sociis commodo fringilla molestie – vestibulum per duis. Na duis.
Dolor habitant accumsan viverra torquent habitasse convallis senectus parturient – cursus praesent. Scelerisque inceptos habitasse potenti eleifend eros parturient montes tincidunt non facilisi feugiat. Suspendisse dictum laoreet, commodo felis malesuada volutpat; nullam venenatis ac porttitor iaculis per. Non natoque urna justo ullamcorper ullamcorper euismod donec tristique maecenas potenti. Facilisis fames platea sociis.
Adipiscing nec inceptos consequat, pulvinar class sed cursus scelerisque sagittis mollis. Dis interdum convallis iaculis donec interdum tortor posuere est purus duis. Mattis id bibendum purus taciti donec egestas tempor id massa nam pharetra taciti sociosqu. Ligula euismod porttitor ornare vehicula ridiculus convallis hendrerit sodales? Nulla curabitur platea.
Ipsum habitasse sodales, libero tellus neque cursus? Dapibus nisi ligula habitant turpis molestie nostra, ultricies malesuada feugiat tortor. Ultricies sagittis donec dis dis nisl consequat lobortis. Eget orci sapien integer nullam per vitae aliquam justo. Phasellus litora natoque nostra himenaeos taciti commodo non rutrum sociosqu faucibus convallis: fringilla imperdiet gravida blandit non vulputate?
Amet est habitant nullam, venenatis euismod praesent placerat cursus tristique lacus. Suspendisse arcu cubilia, hendrerit posuere lacinia quis suscipit! Posuere leo morbi velit egestas et class neque suscipit, risus inceptos mauris. Libero dis taciti ultricies orci ornare augue curae cras morbi. Phasellus sagittis justo fames commodo nisl felis, torquent sociosqu: dui – mollis senectus vestibulum dis sem, phasellus justo ad est aenean.
Elit habitasse sed euismod sed mus diam lacinia. Nibh gravida per congue sodales, aliquet ac mollis dictum? Urna parturient class scelerisque libero aptent varius leo a! Aenean fusce nam pharetra morbi fames scelerisque! Commodo habitasse mauris eros cras dignissim sollicitudin vestibulum nisi magnis faucibus, arcu orci sagittis, euismod vulputate litora tempus dictum class sodales commodo.
Ipsum parturient interdum neque ultrices, porta velit dictumst? Mi malesuada habitant lacinia non felis penatibus tempus blandit, vestibulum nec. Interdum auctor vestibulum gravida cum sodales nulla class? Pellentesque duis enim nostra enim nascetur tempor fringilla ut enim nullam. Feugiat orci penatibus suspendisse laoreet etiam blandit himenaeos per pharetra penatibus auctor eros varius!
Amet et sociis aenean – aliquet magnis volutpat ultricies, mus metus, magna suscipit felis? Est interdum accumsan id cursus neque sagittis sociis habitasse sociis. Pellentesque hac placerat quis cras at sodales dictumst gravida massa montes duis? Laoreet leo ligula integer natoque lectus netus! Congue sodales dictum quam cras fames pellentesque metus posuere netus placerat: porta curabitur senectus eros est lacus.
Amet dapibus laoreet nec augue torquent, per sociosqu vehicula mus. Fames placerat fusce facilisi primis mi lacinia lectus duis! Cubilia tempus aptent luctus eleifend habitasse aliquet a velit? Potenti eu, varius, habitant convallis scelerisque placerat egestas, euismod phasellus mus praesent? Morbi pulvinar mauris sodales aliquet tincidunt ligula, hac; fusce vulputate, dui fermentum vel.
Also, when the content has a fixed size, and should not be allowed to
scroll, set fill = FALSE:
card(
height = 350,
full_screen = TRUE,
card_header(
"Filling plot, short description"
),
plotly_widget,
card_body(
fill = FALSE, gap = 0,
card_title("A subtitle"),
p(class = "text-muted", "And a caption")
)
)A subtitle
And a caption
Multiple columns
As you’ll learn in column-based
layouts, layout_column_wrap() is great for multi-column
layouts that are responsive and accommodate for filling output. Here we have an equal-width
2-column layout using width = 1/2, but it’s also possible
to have varying column
widths.
card(
height = 350,
full_screen = TRUE,
card_header("A multi-column filling layout"),
card_body(
min_height = 200,
layout_column_wrap(
width = 1/2,
plotOutput("p1"),
plotOutput("p2")
)
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Adipiscing fringilla aenean facilisi nulla nullam rutrum: natoque, mattis vulputate dui netus. Hendrerit eleifend porta nisi diam a litora torquent porttitor. Malesuada torquent hac, vel gravida id tempus odio nulla. Mus litora lobortis tempus placerat suscipit varius placerat viverra torquent. Tincidunt nostra euismod nam, laoreet nam maecenas felis habitasse ultrices, natoque dui vestibulum aenean nam hac aliquam.
Consectetur at lacus, tincidunt commodo parturient ad libero nunc viverra. Facilisis nascetur, montes faucibus condimentum varius eget class. Lacinia praesent ultricies suscipit massa potenti auctor malesuada. Id quisque ligula montes velit magnis enim egestas sed maecenas nullam. Sodales nunc diam condimentum sed venenatis ornare inceptos bibendum, vitae, nec viverra accumsan nulla velit placerat felis sapien, nibh aliquet torquent sed mi varius?
Sit ullamcorper vulputate convallis placerat condimentum penatibus senectus duis dis faucibus natoque. Velit porttitor habitasse senectus, habitant augue – condimentum hendrerit augue. Vehicula accumsan, a neque vehicula, leo ridiculus ut taciti congue ullamcorper. Odio eleifend integer, et sociis, massa rhoncus, iaculis, quam primis parturient consequat lobortis lobortis lacinia? Morbi hendrerit nec.
Multiple cards
layout_column_wrap() is especially nice for laying out
multiple cards since each card in a particular row will have the same
height (by default). Learn more in column-based layouts.
layout_column_wrap(
width = 1/2,
height = 300,
card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)Multiple tabs
navset_card_tab() and navset_card_pill()
make it possible to create cards with multiple tabs or pills. These
functions have the same full_screen capabilities as normal
card()s as well some other options like title
(since there is no natural place for a card_header() to be
used). Note that, each nav_panel() object is similar to a
card(). That is, if the direct children aren’t already card
items (e.g., card_title()), they get implicitly wrapped in a
card_body().
library(leaflet)
navset_card_tab(
height = 450,
full_screen = TRUE,
title = "HTML Widgets",
nav_panel(
"Plotly",
card_title("A plotly plot"),
plotly_widget
),
nav_panel(
"Leaflet",
card_title("A leaflet plot"),
leaflet_widget
),
nav_panel(
shiny::icon("circle-info"),
markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
)
)Sidebars
As you’ll learn more about in sidebar
layouts, layout_sidebar() just works when placed inside
in a card(). In this case, if you want fill
items (e.g., plotly_widget) to still fill the card
like we’ve seen before, you’ll need to
set fillable = TRUE in layout_sidebar().
card(
height = 300,
full_screen = TRUE,
card_header("A sidebar layout inside a card"),
layout_sidebar(
fillable = TRUE,
sidebar = sidebar(
actionButton("btn", "A button")
),
plotly_widget
)
)Static images
card_image() makes it easy to embed static (i.e.,
pre-generated) images into a card. Provide a URL to href to
make it clickable. In the case of multiple card_image()s,
consider laying them out in multiple cards
with layout_column_wrap() to produce a grid of clickable
thumbnails.
card(
height = 300,
full_screen = TRUE,
card_image(
file = "shiny-hex.svg",
href = "https://github.com/rstudio/shiny"
),
card_body(
fill = FALSE,
card_title("Shiny for R"),
p(
class = "fw-light text-muted",
"Brought to you by RStudio."
)
)
)
Shiny for R
Brought to you by RStudio.
Flexbox
Both card() and card_body() default to
fillable = TRUE (that is, they are CSS flexbox
containers), which works wonders for facilitating filling outputs, but it also leads to
surprising behavior with inline tags (e.g., actionButton(),
span(), strings, etc). Specifically, each inline tag is
placed on a new line, but in a “normal” layout flow
(fillable = FALSE), inline tags render inline.
card(
card_body(
fillable = TRUE,
"Here's some", tags$i("inline"), "text",
actionButton("btn1", "A button")
),
card_body(
fillable = FALSE,
"Here's some", tags$i("inline"), "text",
actionButton("btn2", "A button")
)
)That said, sometimes working in a flexbox layout is quite useful,
even when working with inline tags. Here we leverage flexbox’s gap
property to control the spacing between a plot, a (full-width) button,
and paragraph. Note that, by using markdown() for the
paragraph, it wraps the results in a <p> tag, which
means the contents of the paragraph are not longer subject to
flexbox layout. If we wanted, we could do something similar to render
the actionButton() inline by wrapping it in a
div().
card(
height = 325, full_screen = TRUE,
card_header("A plot with an action links"),
card_body(
class = "gap-2 container",
plotly_widget,
actionButton(
"go_btn", "Action button",
class = "btn-primary rounded-0"
),
markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
)
)In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.
card(
height = 300, full_screen = TRUE,
card_header(
class = "d-flex justify-content-between",
"Centered plot",
checkboxInput("check", " Check me", TRUE)
),
card_body(
class = "align-items-center",
plotOutput("id", width = "75%")
)
)Shiny
Since this article is statically rendered, the examples here use
statically rendered content/widgets, but the same card()
functionality works for dynamically rendered content via Shiny (e.g.,
plotOutput(), plotlyOutput(), etc).
An additional benefit that comes with using shiny is the ability to
use getCurrentOutputInfo() to render new/different content
when the output container becomes large enough, which is particularly
useful with card(full_screen = T, ...). For example, you
may want additional captions/labels when a plot is large, additional
controls on a table, etc (see the value
boxes article for a clever use of this).
# UI logic
ui <- page_fluid(
card(
max_height = 200,
full_screen = TRUE,
card_header("A dynamically rendered plot"),
plotOutput("plot_id")
)
)
# Server logic
server <- function(input, output, session) {
output$plot_id <- renderPlot({
info <- getCurrentOutputInfo()
if (info$height() > 600) {
# code for "large" plot
} else {
# code for "small" plot
}
})
}
shinyApp(ui, server)Appendix
The following CSS is used to give plotOutput() a
background color; it’s necessary here because this documentation page is
not actually hooked up to a Shiny app, so we can’t show a real plot.